PIZZA	Current compiler version: 0.39d
*A substantial companion to Java*
The Pizzadoc tool

Contents
Home
Mirrors
FAQ

Applications
-PizzaExpress
-Pizzadoc
--And javadoc
--Man page
-SLED
Users

People
Links

Automatic source code documentation generation for Pizza

Documenting source code often takes as long as programming the code itself. Documentation frequently becomes useless after only a few changes in the source: since the source and doumentation are kept in separate files, many programmers will be too busy (or lazy!) to keep the two consistent. Printed documentation is even more difficult to maintain, and so even less useful. An easy, efficient and automatic generator for source code documentation is clearly an extremely useful software engineering tool.

The Java Language Specification sets a standard for documentating Java source code. Each class, variable and method should come with a comment that is organized in a special way - a ``doc comment''. A documentation tool is integrated into the development kit to construct HTML pages from Java source files and their doc comments.

Pizza is a superset of Java, and so it needs an equivalent tool. Thus, pizzadoc is included in the Pizza compiler distribution (versions 38 and above). The pizzadoc manpage gives a brief description of the tool's features and examples of its usage. A discussion of the differences between javadoc and pizzadoc is available, and covers both general and Pizza-specific extensions. Pizzadoc pages for the standard Pizza classes are also available.

Page design: Enno Runne; maintenance: John Maraist.
Java is a trademark of Sun Microsystems.
Comments and bug reports to the Pizza Group, pizza@cis.unisa.edu.au.
All software and documents on the Pizza site are © Copyright 1996, 1997 by the respective authors (as attributed on each; terms for redistribution are available).